Skip to content
Cloud APIs
/
/
/
Search CRSes

Search CRSes

Request

Search CRS records (any sub-type) by keywords and/or geographic area. Geographical constraints are passed (optionally) as parameters via the query URL, search keywords are passed via the request body. Query syntax follows Lucene style, default operator for multiple expressions is AND. The following keywords are supported: 'name:', 'description:', 'type:', 'authority:', 'code:', 'deprecationState:', 'remarks:', 'lastModified:', 'source:', 'wellKnownText:', 'crsType:', 'baseCRS.authority:', 'baseCRS.code:', 'horizontalCRS.authority:', 'horizontalCRS.code:', 'verticalCRS.authority:', 'verticalCRS.code:', 'lateBoundCRS.authority:', 'lateBoundCRS.code:', 'ct.authority:', 'ct.code:', 'transformationReady:'. followed by a value. Example: 'transformationReady:true'. longitudeLeft - the left WGS 84 longitude limit of the search box. latitudeLower - the lower WGS 84 latitude limit of the search box. longitudeRight - the right WGS 84 longitude limit of the search box. latitudeUpper - The upper WGS 84 latitude limit of the search box.

Security
bearer
Query
longitudeLeftnumber, (double), [ -180 .. 180 ]

The left (western) longitude of the bounding box, in decimal degrees.

latitudeLowernumber, (double), [ -90 .. 90 ]

The lower (southern) latitude of the bounding box, in decimal degrees.

longitudeRightnumber, (double), [ -180 .. 180 ]

The right (eastern) longitude of the bounding box, in decimal degrees.

latitudeUppernumber, (double), [ -90 .. 90 ]

The upper (northern) latitude of the bounding box, in decimal degrees.

offsetinteger, (int32)

The offset of the first item in the list.

Default:0
limitinteger, (int32)

The maximum number of items returned.

Default:100
modestring

The mode of return: 'persistable_reference' (default) string or 'essence' structure or 'persistable_reference_essence' i.e. the combination of other 2 options.

Default:"persistable_reference"
Headers
data-partition-idstringrequired

desired data partition id

Bodyapplication/jsonrequired

A Lucene style keyword query. One of the following keywords 'name:', 'description:', 'type:', 'authority:', 'code:', 'deprecationState:', 'remarks:', 'lastModified:', 'source:', 'wellKnownText:', 'crsType:', 'baseCRS.authority:', 'baseCRS.code:', 'horizontalCRS.authority:', 'horizontalCRS.code:', 'verticalCRS.authority:', 'verticalCRS.code:', 'lateBoundCRS.authority:', 'lateBoundCRS.code:', 'ct.authority:', 'ct.code:', 'transformationReady:'. followed by a value. Example: 'transformationReady:true'.

querystring

The Lucene style query string with keywords.

Example:"baseCRS.code:4267 transformationReady:true"
curl -i -X POST \
  'https://as5.api.enterprisedata.slb.com/api/crs/catalog/v2/search/crs?longitudeLeft=-180&latitudeLower=-90&longitudeRight=-180&latitudeUpper=-90&offset=0&limit=100&mode=persistable_reference' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'data-partition-id: string' \
  -d '{
    "query": "baseCRS.code:4267 transformationReady:true"
  }'

Responses

A successful response

Bodyapplication/json
crsesArray of objects(Generic CRS)

An array of (any sub-type of) CRS

countinteger, (int32)

Number of elements in the response.

offsetinteger, (int32)

Offset to the first catalog item in the response, as set in the request.

totalCountinteger, (int32)

Number of elements in the catalog.

Response
{
  "crses": [
    { … }
  ],
  "count": 0,
  "offset": 0,
  "totalCount": 0
}